home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Development Foundation 1.1 for IRIX 6.4
/
SGI IRIX 6.4 Development Foundation 1.1.iso
/
dist
/
dist6.4
/
patchSG0002052.idb
/
usr
/
share
/
catman
/
u_man
/
cat1
/
explain.z
/
explain
Wrap
Text File
|
1997-09-05
|
17KB
|
305 lines
EXPLAIN(1) Last changed: 7-21-97
NNAAMMEE
eexxppllaaiinn - Displays the explanation for an error message
SSYYNNOOPPSSIISS
eexxppllaaiinn _m_s_g_i_d
IIMMPPLLEEMMEENNTTAATTIIOONN
UNICOS systems
IRIX systems
DDEESSCCRRIIPPTTIIOONN
The eexxppllaaiinn utility retrieves and outputs a message explanation from
an online explanation catalog. If the output device is a terminal,
the output of eexxppllaaiinn is piped through the pager specified in the
PPAAGGEERR variable. If PPAAGGEERR is not specified, the default pager mmoorree --ss
is used. If the output device is not a terminal, the output of
eexxppllaaiinn is sent to the standard output device (ssttddoouutt).
The eexxppllaaiinn utility requires the following argument:
_m_s_g_i_d Specifies the message ID string associated with a message that
appears when an error message is output. This string consists
of the product group code and the message number. The product
group code (_g_r_o_u_p) is a string that identifies the product
issuing the message. The message number (_m_s_g#) specifies which
message within the product you have received. Enter the
message ID as an argument to eexxppllaaiinn in the form _g_r_o_u_p_m_s_g# or
in the form _g_r_o_u_p-_m_s_g#. If the group code ends in one or more
digits (for example, ccff9900), you must use the form that includes
the dash (--).
RReeccooggnniizzeedd GGrroouupp CCooddeess
The following tables show the products and group codes that have
message and explanation catalogs on UNICOS systems and on IRIX
systems. The first column lists the group code (needed to look up the
explanations for messages); the second column gives the complete name
of the software product or products associated with the group code;
the third column lists the publication number in which explanations
for messages in that group code can be found.
UNICOS group codes
---------------------------------------------------------------
Group Code Software Product Publication
---------------------------------------------------------------
aapppprreennttiiccee MPP Apprentice tool Online only
aass CAL assembler SR-3108
aassmm Cray Assembler for MPP (CAM) Online only
aattcchhoopp aattcchhoopp(1) performance tool Online only
aatteexxppeerrtt aatteexxppeerrtt(1) performance tool Online only
bbuuiillddddeeffss bbuuiillddddeeffss(1) command of the UNICOS Online only
glossary
cccc Cray Standard C compiler Online only
ccff9900 CF90 Fortran language Online only
cclldd Loader for CRAY T3E systems Online only
ccmmdd UNICOS utilities that are compliant Online only
with XPG4
ddbbgg ccddbbxx(1), ddeebbuugg(1), ssyymmddeebbuugg(3F), and Online only
ssyymmdduummpp(3F) debugging commands
ddeeffiinnee ddeeffiinnee(1) command of the UNICOS Online only
glossary
ddeepplliibb ddeepplliibb(1) command Online only
ddff ddff(1) utility Online only
ddmm Data Migration Facility SG-2135
dduu dduu(1) utility Online only
eexx eexx(1) and vvii(1) utilities Online only
fflloowwvv fflloowwvviieeww(1) performance tool Online only
ffmmpp ffmmpp(1) Fortran vectorization SR-3771
translator
ffpppp ffpppp(1) Fortran vectorization analyzer SR-3771
ffssqquuoottaa File system quota feature Online only
hhppmm hhppmm(1) performance tool Online only
hhppmmaallll hhppmmaallll(8) performance tool Online only
hhppmmfflloopp hhppmmfflloopp(8) performance tool Online only
jjtt jjtt(1) performance tool Online only
jjuummppvv jjuummppvviieeww(1) performance tool Online only
llddrr sseeggllddrr(1) and lldd(1) loader commands SR-0066
lliibb Fortran and I/O libraries Online only
lliibbmm Mathematical libraries SG-2138
lliibbpp Pascal library Online only
llpprrooff lliibbpprrooff library Online only
llttrraaccee Jumptrace library Online only
mmppppllddrr Loader for CRAY T3D systems Online only
mmttdduummpp mmttdduummpp(1) performance tool Online only
nnqqss Network Queuing System Online only
ppeerrff lliibbppeerrff library Online only
ppeerrffddmmpp ppeerrffddmmpp(1) performance tool Online only
ppeerrffvv ppeerrffvviieeww(1) performance tool Online only
pprroocc pprrooccssttaatt(1) performance tool Online only
pprrooccvv pprrooccvviieeww(1) performance tool Online only
pprrooff pprrooff(1) performance tool Online only
pprrooffvv pprrooffvviieeww(1) performance tool Online only
ppss ppss(1) utility Online only
sshh Standard shell Online only
ssyyss UNICOS system error list SR-2012
(ssyysseerrrrlliisstt[])
ssyysslloogg System message logger (nneewwssyyss(8) and Online only
ssyyssllooggdd(8))
ttaallkk ttaallkk(1B) utility Online only
uurrmm Unified Resource Manager Online only
uussmm UNICOS Source Manager (USM) SG-2097
---------------------------------------------------------------
IRIX group codes
---------------------------------------------------------------
Group Code Software Product Publication
---------------------------------------------------------------
ccff9900 ff9900 version 7.2 Online only
lliibb Fortran 90 library version 2.0, and Online only
lliibbffffiioo
mmssggssyyss eexxppllaaiinn(1) and ccaatteerrrr(1) utilities Online only
---------------------------------------------------------------
LLooccaattiioonn ooff EExxppllaannaattiioonn CCaattaallooggss
To find the explanation for the message, eexxppllaaiinn searches the path
specified in the NNLLSSPPAATTHH environment variable for the _g_r_o_u_p..eexxpp file.
The value of the NNLLSSPPAATTHH variable depends on the LLAANNGG environment
variable or the LLCC__MMEESSSSAAGGEESS category. If eexxppllaaiinn cannot access an
existing explanation catalog, check the value of the NNLLSSPPAATTHH
environment variable and either the LLAANNGG environment variable or the
LLCC__MMEESSSSAAGGEESS category to ensure that the path name of the catalog is in
the message system search path.
On UNICOS systems, you can use the wwhhiicchhccaatt(1) utility to determine
which catalog is being accessed by eexxppllaaiinn. For more information, see
wwhhiicchhccaatt(1).
On UNICOS systems, see the ccaattooppeenn(3C) man page for a description of
the NNLLSSPPAATTHH, LLAANNGG, and LLCC__MMEESSSSAAGGEESS components.
On IRIX systems, see eennvviirroonn(5) for a description of the NNLLSSPPAATTHH,
LLAANNGG, and LLLLCC__MMEESSSSAAGGEESS components.
MMeessssaaggee FFoorrmmaatt VVaarriiaabblleess
If _m_s_g_i_d does not appear with the error message or if you want to
change the format of the messages you receive, you can modify your
MMSSGG__FFOORRMMAATT and CCMMDDMMSSGG__FFOORRMMAATT environment variables. Both variables
can be set to define the fields and the order of the fields to be
included in message output.
The MMSSGG__FFOORRMMAATT variable controls the format in which you receive error
messages from programs that use the message formatting function
ccaattmmssggffmmtt(3C). On UNICOS systems, these are most messages in group
codes other than ccmmdd. On IRIX systems, these are most messages in
group codes other than mmssggssyyss.
On UNICOS systems, the CCMMDDMMSSGG__FFOORRMMAATT variable controls the format in
which you receive error messages issued by system utilities that are
included in the XPG4 standard. These are messages in the ccmmdd group
code. A separate environment variable is provided to control message
output from these utilities, because it is often desirable to capture
and process this output through a script or program; limiting the
output to one line makes this easier. The default format (shown
below) for non-utility messages outputs at least two lines. The
CCMMDDMMSSGG__FFOORRMMAATT variable exists to provide a one-line default format for
utility messages.
On IRIX systems, the eexxppllaaiinn and ccaatteerrrr utilities use either
CCMMDDMMSSGG__FFOORRMMAATT or MMSSGG__FFOORRMMAATT variables; however, CCMMDDMMSSGG__FFOORRMMAATT is used
before MMSSGG__FFOORRMMAATT.
MMeessssaaggee FFoorrmmaatt SSyynnttaaxx
Valid fields for MMSSGG__FFOORRMMAATT and CCMMDDMMSSGG__FFOORRMMAATT are as follows:
%%GG Group code
%%NN Message number
%%CC Command name
%%SS Severity level
%%PP Position of the error
%%MM Message text
%%DD Debugging information
%%TT Time stamp
If one of the %% fields is not present in the contents of MMSSGG__FFOORRMMAATT or
CCMMDDMMSSGG__FFOORRMMAATT, the corresponding message field is not printed.
The default message format is produced by the following assumed
MMSSGG__FFOORRMMAATT contents:
%G-%N %C: %S %P\n %M\n
For messages issued by UNICOS utilities, and by the IRIX utilities
eexxppllaaiinn(1) and ccaatteerrrr(1), the default message format is produced by
the following assumed CCMMDDMMSSGG__FFOORRMMAATT contents:
%G-%N: %C %M\n
Messages issued from the ccmmdd group code determine their format
according to the following precedence:
1. Content of CCMMDDMMSSGG__FFOORRMMAATT variable, if it exists
2. Content of MMSSGG__FFOORRMMAATT variable, if it exists
3. Default message format for utilities
The format of the time stamp (%%TT) is equivalent to that produced by
the ccffttiimmee(3C) function and can be overridden by the CCFFTTIIMMEE
environment variable. For details about time stamp formats, see the
ssttrrffttiimmee(3C) man page, which documents the ccffttiimmee function.
The Standard C pprriinnttff escape sequences also can be embedded in the
contents of MMSSGG__FFOORRMMAATT. The following table lists special characters
that can be embedded.
--------------------------------
Description Symbol Sequence
--------------------------------
New-line NL \\nn
character (LF)
Horizontal tab HT \\tt
Vertical tab VT \\vv
Backspace BS \\bb
Carriage return CR \\rr
Form feed FF \\ff
Audible alert BEL \\aa
Backslash \ \\\\
Question mark ? \\??
Single ' \\''
quotation mark
Double " \\""
quotation mark
Octal number _o_o_o \\_o_o_o
Hexadecimal _h_h \\xx_h_h
number
--------------------------------
The escape \_o_o_o consists of the backslash followed by 1, 2, or 3 octal
digits, which are taken to specify the value of the desired character.
A common example of this construction is \\00, which specifies the null
character. The escape \\xx_h_h consists of the backslash, followed by xx,
followed by hexadecimal digits, which are taken to specify the value
of the desired character. There is no limit on the number of digits,
but the behavior is undefined if the resulting character value exceeds
that of the largest character.
Any characters other than those listed in this table are passed
through without the backslash, (for example, \\qq produces qq).
NNOOTTEESS
On UNICOS systems, if this utility is installed with a privilege
assignment list (PAL), a user with one of the following active
categories is allowed to perform the actions shown:
AAccttiivvee CCaatteeggoorryy AAccttiioonn
ssyysstteemm, sseeccaaddmm In a privileged administrator shell environment,
allowed to write shell-redirected output to any
file.
ssyyssaaddmm Shell-redirected output is subject to security
label restrictions.
If the PPRRIIVV__SSUU configuration option is enabled, the super user can
write shell-redirected output to any file.
SSEEEE AALLSSOO
UUNNIICCOOSS ssyysstteemmss
ccaatteerrrr(1), ccaattxxtt(1), ggeennccaatt(1), wwhhiicchhccaatt(1)
ccaattggeettmmssgg(3C), ccaattggeettss(3C), ccaattmmssggffmmtt(3C), ccaattooppeenn(3C), ssttrrffttiimmee(3C)
in the _U_N_I_C_O_S _S_y_s_t_e_m _L_i_b_r_a_r_i_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2080
nnll__ttyyppeess(5), mmssgg(7D) in the _U_N_I_C_O_S _F_i_l_e _F_o_r_m_a_t_s _a_n_d _S_p_e_c_i_a_l _F_i_l_e_s
_R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2014
IIRRIIXX ssyysstteemmss
ccaatteerrrr(1), ggeennccaatt(1)
ccaattggeettmmssgg(3C), ccaattmmssggffmmtt(3C)
mmssgg(7D)
CCrraayy RReesseeaarrcchh ppuubblliiccaattiioonnss
_U_N_I_C_O_S _M_e_s_s_a_g_e _S_y_s_t_e_m _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e, publication SG-2121
_S_e_g_m_e_n_t _L_o_a_d_e_r (_S_E_G_L_D_R) _a_n_d _l_d _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-0066
_U_N_I_C_O_S _S_y_s_t_e_m _C_a_l_l_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2012
_U_N_I_C_O_S _S_o_u_r_c_e _M_a_n_a_g_e_r (_U_S_M) _U_s_e_r'_s _G_u_i_d_e, publication SG-2097
_C_r_a_y _D_a_t_a _M_i_g_r_a_t_i_o_n _F_a_c_i_l_i_t_y (_D_M_F) _A_d_m_i_n_i_s_t_r_a_t_o_r'_s _G_u_i_d_e, publication
SG-2135
_I_n_t_r_i_n_s_i_c _P_r_o_c_e_d_u_r_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2138
_C_r_a_y _A_s_s_e_m_b_l_y _L_a_n_g_u_a_g_e (_C_A_L) _f_o_r _C_r_a_y _P_V_P _S_y_s_t_e_m_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l,
publication SR-3108
_U_N_I_C_O_S _U_s_e_r _C_o_m_m_a_n_d_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2011, for the
printed version of this man page.